/*
 * Copyright (C) 2008 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.dx.util;

/**
 * A set of integers
 */
public interface IntSet {

	/**
	 * Adds an int to a set
	 * 
	 * @param value
	 *            int to add
	 */
	void add(int value);

	/**
	 * Removes an int from a set.
	 * 
	 * @param value
	 *            int to remove
	 */
	void remove(int value);

	/**
	 * Checks to see if a value is in the set
	 * 
	 * @param value
	 *            int to check
	 * @return true if in set
	 */
	boolean has(int value);

	/**
	 * Merges {@code other} into this set, so this set becomes the union of the
	 * two.
	 * 
	 * @param other
	 *            {@code non-null;} other set to merge with.
	 */
	void merge(IntSet other);

	/**
	 * Returns the count of unique elements in this set.
	 * 
	 * @return {@code > = 0;} count of unique elements
	 */
	int elements();

	/**
	 * Iterates the set
	 * 
	 * @return {@code non-null;} a set iterator
	 */
	IntIterator iterator();
}
